Routines (alphabetical) > Routines: H > HDF-EOS Routines > EOS_SW_DEFIDXMAP

EOS_SW_DEFIDXMAP

Defines a nonregular mapping between the geolocation and the data dimension.

If there does not exist a regular (linear) mapping between a geolocation and data dimension, then the mapping must be made explicit. Each element of the index array, whose dimension is given by the geolocation size, contains the element number (0-based) of the corresponding data dimension.

Syntax

Result = EOS_SW_DEFIDXMAP(swathID, geodim, datadim, index)

Return Value

Returns SUCCEED (0) if successful and FAIL (–1) otherwise.

Arguments

swathID

Swath id (long) returned by EOS_SW_CREATE or EOS_SW_ATTACH.

geodim

Geolocation dimension name (string).

datadim

Data dimension name (string).

index

The array (long) containing the indices of the data dimension to which each geolocation element corresponds.

Keywords

None

Examples

In this example, we consider the (simple) case of a geolocation dimension IdxGeo of size 5 and a data dimension IdxData of size 8. In this case, the 0th element of IdxGeo will correspond to the 0th element of IdxData, the 1st element of IdxGeo to the 2nd element of IdxData, etc.:

index = [0,2,3,6,7]

status = EOS_SW_DEFIDXMAP(swathID, "IdxGeo", "IdxData", index)

Version History

 

5.2

Introduced